blank_degrees.module

  1. 6.x modules/blank_degrees/blank_degrees.module
  2. 4.x modules/blank_degrees/blank_degrees.module
  3. 5.x modules/blank_degrees/blank_degrees.module

File

modules/blank_degrees/blank_degrees.module
View source
  1. <?php
  2. /**
  3. * Implementation of hook_menu
  4. */
  5. function blank_degrees_menu() {
  6. $items = array();
  7. $items["tools/blank-degrees"] = array(
  8. "title" => "Blank Degree Search",
  9. "description" => "Browse through available degree plans as they appear in " . variable_get("system_name", "FlightPath"),
  10. "page_callback" => "fp_render_form",
  11. "page_arguments" => array("blank_degrees_select_degree_form"),
  12. "access_arguments" => array('access_blank_degrees'),
  13. "page_settings" => array(
  14. "page_hide_report_error" => TRUE,
  15. "target" => "_blank",
  16. ),
  17. "type" => MENU_TYPE_NORMAL_ITEM,
  18. "weight" => 10,
  19. );
  20. $items["blank-degrees/display"] = array(
  21. "title" => "Blank Degrees - Display",
  22. "page_callback" => "blank_degrees_display_blank_degree",
  23. "access_arguments" => array('access_blank_degrees'),
  24. "page_settings" => array(
  25. "display_currently_advising" => TRUE,
  26. "page_hide_report_error" => TRUE,
  27. "page_show_title" => TRUE,
  28. "menu_links" => array(
  29. 0 => array(
  30. "text" => "Degrees",
  31. "path" => "tools/blank-degrees",
  32. "query" => "blank_catalog_year=%BLANK_CATALOG_YEAR%&school_id=%SCHOOL_ID%",
  33. ),
  34. ),
  35. ),
  36. "tab_family" => "blank_degrees",
  37. "type" => MENU_TYPE_TAB,
  38. );
  39. return $items;
  40. }
  41. /**
  42. * This is an implementation of hook_menu_handle_replacement_pattern.
  43. * It will search for and replace replacement patterns which we are aware of it in $str.
  44. */
  45. function blank_degrees_menu_handle_replacement_pattern($str) {
  46. if (strpos($str, "%BLANK_CATALOG_YEAR%") !== 0) {
  47. // It contains this replacement pattern!
  48. $str = str_replace("%BLANK_CATALOG_YEAR%", @$_REQUEST["blank_catalog_year"], $str);
  49. }
  50. $school_id = 0;
  51. if (isset($_REQUEST['school_id'])) {
  52. $school_id = intval($_REQUEST['school_id']);
  53. }
  54. if (strpos($str, "%SCHOOL_ID%") !== 0) {
  55. // It contains this replacement pattern!
  56. $str = str_replace("%SCHOOL_ID%", $school_id, $str);
  57. }
  58. return $str;
  59. }
  60. /**
  61. * Implements hook_prereqs_get_prereq_warnings_for_course
  62. *
  63. * For a blank degree, we don't want to worry about any warnings.
  64. */
  65. function blank_degrees_prereqs_get_prereq_warnings_for_course(&$rtn, $course, $student) {
  66. if (isset($_REQUEST['blank_degree_id']) && $_REQUEST['blank_degree_id'] != '') {
  67. // We are on a blank degree, so remove any prereq warnings.
  68. $rtn = array();
  69. }
  70. }
  71. function blank_degrees_display_blank_degree() {
  72. global $screen, $student, $fp;
  73. $blank_degree_id = $_REQUEST["blank_degree_id"];
  74. $blank_catalog_year = $_REQUEST["blank_catalog_year"];
  75. $school_id = 0;
  76. if (isset($_REQUEST['school_id'])) {
  77. $school_id = intval($_REQUEST['school_id']);
  78. }
  79. @$blank_print = $_REQUEST["blank_print"];
  80. @$blank_view = $_REQUEST["blank_view"];
  81. // If we used the word "current" for catalog_year, then find out what the current is.
  82. if (strtolower($blank_catalog_year) == "current") {
  83. $blank_catalog_year = variable_get_for_school("current_catalog_year", 2006, $school_id);
  84. }
  85. $blank_degree = NULL;
  86. // If the blank_degree_id begins with "major_code_" then figure out the degree based on major_code.
  87. if (strstr($blank_degree_id, "major_code_")) {
  88. $blank_major_code = str_replace("major_code_", "", $blank_degree_id);
  89. // Okay, figure out the degree id based on the major code and catalog year.
  90. $db = get_global_database_handler();
  91. $blank_degree_id = $db->get_degree_id($blank_major_code, $blank_catalog_year);
  92. if (!$blank_degree_id) {
  93. // Couldn't be found!
  94. $rtn = "<br>" . t("Checking for major code: %blank_major_code, year: %blank_catalog_year
  95. <br><br>
  96. Sorry, but that major code/track combination and catalog year could not be found. Please check your URL and try again.", array('%blank_major_code' => $blank_major_code, '%blank_catalog_year' => $blank_catalog_year));
  97. return $rtn;
  98. }
  99. }
  100. else {
  101. // Find out the major_code for this blank_degree_id...
  102. $blank_degree = new DegreePlan($blank_degree_id, NULL, TRUE);
  103. $blank_major_code = $blank_degree->major_code;
  104. // If there is a track, tack it on.
  105. if ($blank_degree->track_code != "") {
  106. if (!strstr($blank_major_code, "|")) $blank_major_code .= "|";
  107. $blank_major_code .= "_" . $blank_degree->track_code;
  108. }
  109. }
  110. $render = array();
  111. $render['#id'] = 'blank_degrees_display_blank_degree';
  112. $render['#view'] = $blank_view;
  113. // Are we in draft mode?
  114. if ($_SESSION["fp_draft_mode"] == "yes") {
  115. $GLOBALS["fp_advising"]["bool_use_draft"] = true;
  116. }
  117. else {
  118. $GLOBALS["fp_advising"]["bool_use_draft"] = false;
  119. }
  120. fp_add_css(fp_get_module_path("advise") . "/css/advise.css");
  121. fp_add_js(fp_get_module_path("advise") . "/js/advise.js");
  122. $student = new Student();
  123. $student->load_student();
  124. $student->student_id = "000000000";
  125. $student->school_id = $school_id;
  126. $student->name = "Blank Degree";
  127. $degree_plan = new DegreePlan($blank_degree_id);
  128. $degree_plan->load_descriptive_data();
  129. $degree_plan->school_id = $school_id;
  130. $student->catalog_year = $degree_plan->catalog_year;
  131. $fp = new FlightPath($student, $degree_plan);
  132. $screen = new AdvisingScreen("", $fp, "not_advising");
  133. if ($blank_view == "type")
  134. {
  135. $screen = new AdvisingScreenTypeView("", $fp, "not_advising");
  136. $screen->view = "type";
  137. }
  138. $screen->bool_blank = TRUE;
  139. if ($blank_print == "yes")
  140. {
  141. $screen->bool_print = TRUE;
  142. }
  143. $screen->build_screen_elements();
  144. $title = $degree_plan->title;
  145. if ($degree_plan->track_title != "") {
  146. $title .= " - " . $degree_plan->track_title;
  147. }
  148. fp_set_title($title);
  149. $render['#fp'] = $fp;
  150. $render['#degree_plan'] = $blank_degree;
  151. $render['#blank_catalog_year'] = $blank_catalog_year;
  152. $render['#screen'] = $screen;
  153. $render['#student'] = $student;
  154. $render['degree_plan_wrapper_top'] = array(
  155. 'value' => "<div class='degree-plan-wrapper'>",
  156. 'weight' => 100,
  157. );
  158. $render['semester_table_start'] = array(
  159. 'value' => "<table class='fp-semester-table'>",
  160. 'weight' => 200,
  161. );
  162. $render['screen_display_screen'] = array(
  163. 'value' => $screen->display_screen(),
  164. 'weight' => 300,
  165. );
  166. $render['semester_table_end'] = array(
  167. 'value' => "</table>",
  168. 'weight' => 400,
  169. );
  170. $render['degree_plan_wrapper_bottom'] = array(
  171. 'value' => "</div>",
  172. 'weight' => 500,
  173. );
  174. if (user_has_permission("blank_degrees_view_url_options") && !$screen->bool_print) {
  175. // If the user has permissions, show them the extra URL options. (but don't bother in print mode)
  176. $render['url_options_html'] = array(
  177. 'value' => fp_render_c_fieldset("
  178. <div style='font-size: 0.85em;'>
  179. " . t("This degree may be linked to directly using the following URLs:") . "
  180. <ul>
  181. <li>Internal ID for $blank_catalog_year: <a href='" . $GLOBALS["fp_system_settings"]["base_url"] . "/" . fp_url("blank-degrees/display", "blank_degree_id=$blank_degree_id&blank_catalog_year=$blank_catalog_year&school_id=$school_id", FALSE) . "'>Link</a></li>
  182. <li>Major-code $blank_major_code for $blank_catalog_year: <a href='" . $GLOBALS["fp_system_settings"]["base_url"] . "/" . fp_url("blank-degrees/display", "blank_degree_id=major_code_$blank_major_code&blank_catalog_year=$blank_catalog_year&school_id=$school_id", FALSE) . "'>Link</a></li>
  183. <li>Major-code $blank_major_code always <b>current</b> catalog: <a href='" . $GLOBALS["fp_system_settings"]["base_url"] . "/" . fp_url("blank-degrees/display", "blank_degree_id=major_code_$blank_major_code&blank_catalog_year=current&school_id=$school_id", FALSE) . "'>Link</a></li>
  184. </ul>
  185. </div>
  186. ", t("View URL Options"), TRUE, 'view-url-options-fs'),
  187. 'weight' => 2000,
  188. );
  189. }
  190. // Add in the required "advising variables"
  191. //$rtn .= $screen->get_hidden_advising_variables("save_draft");
  192. // Figure out what the page's sub-tabs should be, and set them.
  193. $tab_array = array();
  194. $tab_array[0]["title"] = "Display by Year";
  195. $tab_array[0]["active"] = ($screen->view != "type");
  196. $tab_array[0]["on_click"] = "window.location=\"" . fp_url("blank-degrees/display", "blank_degree_id=$blank_degree_id&blank_catalog_year=$blank_catalog_year&blank_view=year&school_id=$school_id") . "\";";
  197. $tab_array[1]["title"] = "Display by Type";
  198. $tab_array[1]["active"] = ($screen->view == "type");
  199. $tab_array[1]["on_click"] = "window.location=\"" . fp_url("blank-degrees/display", "blank_degree_id=$blank_degree_id&blank_catalog_year=$blank_catalog_year&blank_view=type&school_id=$school_id") . "\";";
  200. fp_set_page_sub_tabs($tab_array);
  201. watchdog("blank_degrees", "User viewed blank degree: @year,@degree,@title", array("@year" => $blank_catalog_year, "@degree" => $blank_degree_id, "@title" => $title));
  202. return fp_render_content($render);
  203. }
  204. function blank_degrees_perm() {
  205. return array(
  206. 'access_blank_degrees' => array(
  207. 'title' => t('Access blank degrees'),
  208. 'description' => t('This permission allows the user to view the blank degrees.'),
  209. ),
  210. "blank_degrees_view_url_options" => array(
  211. "title" => t("View URL options"),
  212. "description" => t("View URL options at the bottom of blank degrees. Useful if you allow anonymous users to access blank degrees."),
  213. ));
  214. }
  215. function blank_degrees_select_school_form() {
  216. $form = array();
  217. $options = schools_get_schools_for_fapi(TRUE, FALSE); // we don't need special permissions to view.
  218. $form['school_id'] = array(
  219. 'type' => 'select',
  220. 'label' => t('Please begin by selecting a school:'),
  221. 'options' => $options,
  222. 'value' => @$_REQUEST['school_id'],
  223. 'hide_please_select' => TRUE,
  224. 'required' => TRUE,
  225. );
  226. $form['from_select_school'] = array(
  227. 'type' => 'hidden',
  228. 'value' => 'yes',
  229. );
  230. $form['submit_btn'] = array(
  231. 'type' => 'submit',
  232. 'value' => t("Continue"),
  233. );
  234. return $form;
  235. }
  236. /**
  237. * This form lets the user select which degree they wish to view.
  238. */
  239. function blank_degrees_select_degree_form() {
  240. $form = array();
  241. $m = 0;
  242. $bool_show_continue = TRUE;
  243. // Are we in draft mode?
  244. if ($_SESSION["fp_draft_mode"] == "yes") {
  245. $GLOBALS["fp_advising"]["bool_use_draft"] = true;
  246. }
  247. else {
  248. $GLOBALS["fp_advising"]["bool_use_draft"] = false;
  249. }
  250. $school_id = 0;
  251. if (module_enabled("schools")) { // The schools module is enabled. We need to first ask what school we want to look at.
  252. if (!isset($_REQUEST['school_id'])) {
  253. $form = blank_degrees_select_school_form();
  254. return $form;
  255. } // not isset school_id
  256. $school_id = intval($_REQUEST['school_id']);
  257. $form['mark_current_school'] = array(
  258. 'value' => "<div class='current-school'>" . t("Current school: ") . "<strong>" . schools_get_school_name_for_id($school_id) . "</strong>
  259. - " . l(t("Change?"), "tools/blank-degrees") . "</div>",
  260. );
  261. }
  262. $form['school_id'] = array(
  263. 'type' => 'hidden',
  264. 'value' => $school_id,
  265. );
  266. @$blank_catalog_year = $_REQUEST["blank_catalog_year"];
  267. // If we used the word "current" for catalog_year, then find out what the current is.
  268. if (strtolower($blank_catalog_year) == "current") {
  269. $blank_catalog_year = variable_get_for_school("current_catalog_year", 2006, $school_id);
  270. }
  271. if ($blank_catalog_year == "") {
  272. // The user must first select the desired catalog year.
  273. $catalog_year_options = array();
  274. $current_catalog_year = variable_get_for_school("current_catalog_year", 2006, $school_id);
  275. if ($GLOBALS["fp_advising"]["bool_use_draft"]) {
  276. $current_catalog_year = variable_get_for_school("current_draft_catalog_year", 2006, $school_id);
  277. }
  278. $earliest_catalog_year = variable_get_for_school("earliest_catalog_year", 2006, $school_id);
  279. for($t = $current_catalog_year; $t >= $earliest_catalog_year; $t--) {
  280. $catalog_year_options[$t] = "$t-" . ($t+1);
  281. }
  282. $form["blank_catalog_year"] = array(
  283. "type" => "select",
  284. "label" => t("Please select a catalog year:"),
  285. "hide_please_select" => TRUE,
  286. "options" => $catalog_year_options,
  287. "weight" => 10,
  288. );
  289. }
  290. else {
  291. // Catalog year WAS specified. So, ask the user to select a degree now.
  292. $form["blank_catalog_year"] = array(
  293. "type" => "hidden",
  294. "value" => $blank_catalog_year,
  295. );
  296. $form["mark_searching_in_year"] = array(
  297. "value" => t("Searching degrees in %year.", array("%year" => $blank_catalog_year . "-" . ($blank_catalog_year+1))) . "
  298. " . l(t("Change?"), "tools/blank-degrees", "school_id=$school_id"),
  299. "weight" => 0,
  300. );
  301. $school_id = 0;
  302. if (isset($_REQUEST['school_id'])) {
  303. $school_id = intval($_REQUEST['school_id']);
  304. }
  305. $mobile_markup = "";
  306. $degree_options = array();
  307. $db = get_global_database_handler();
  308. if ($degree_array = $db->get_degrees_in_catalog_year($blank_catalog_year, TRUE, $GLOBALS["fp_advising"]["bool_use_draft"], FALSE, array(1,2), $school_id)) {
  309. foreach($degree_array as $major_code => $value) {
  310. if (trim($value["title"]) == ""){continue;}
  311. $degree_id = $value["degree_id"];
  312. $title = $value["title"];
  313. if ($value["degree_class"] == "G") {
  314. $title = "(" . t("Graduate") . ") " . $title;
  315. }
  316. // if title is too long, shorten it.
  317. $maxlen = 95;
  318. if (strlen($title) > $maxlen) {
  319. $title = substr($title, 0, $maxlen - 3) . "...";
  320. }
  321. $degree_options[$degree_id] = $title;
  322. $mobile_markup .= "<a class='degree-search-degree-row'
  323. href='" . fp_url("blank-degrees/display", "blank_degree_id=$degree_id&blank_catalog_year={$_REQUEST["blank_catalog_year"]}") . "'>
  324. <div class='degree-search-degree-title'>$title</div>
  325. </a>";
  326. }
  327. }
  328. $form["blank_degree_id"] = array(
  329. "label" => t("Please select a degree"),
  330. "type" => "select",
  331. "options" => $degree_options,
  332. "weight" => 50,
  333. );
  334. }
  335. if ($bool_show_continue) {
  336. $form["submit"] = array(
  337. "type" => "submit",
  338. "prefix" => "",
  339. "value" => t("Continue"),
  340. "weight" => 100,
  341. );
  342. }
  343. return $form;
  344. }
  345. /**
  346. * Submit handler for degree selection
  347. */
  348. function blank_degrees_select_degree_form_submit($form, $form_state) {
  349. // Are we first selecting a school?
  350. if (isset($form_state['POST']['from_select_school']) && $form_state['POST']['from_select_school'] == 'yes') {
  351. fp_goto('tools/blank-degrees', 'school_id=' . intval($form_state['POST']['school_id']));
  352. return;
  353. }
  354. $school_id = intval($form_state['values']['school_id']);
  355. // If all the user did was select catalog year, we need to redirect
  356. // back to the form with blank_catalog_year set.
  357. if ($form_state["values"]["blank_degree_id"] == "" && $form_state["values"]["blank_catalog_year"] != "") {
  358. // Go to degree selection.
  359. fp_goto("tools/blank-degrees", "blank_catalog_year=" . $form_state["values"]["blank_catalog_year"] . "&school_id=$school_id");
  360. return;
  361. }
  362. else if ($form_state["values"]["blank_degree_id"] != "" && $form_state["values"]["blank_catalog_year"] != ""){
  363. // Send them to the blank degree page
  364. fp_goto("blank-degrees/display", "blank_degree_id=" . $form_state["values"]["blank_degree_id"] . "&blank_catalog_year=" . $form_state["values"]["blank_catalog_year"] . "&school_id=$school_id");
  365. return;
  366. }
  367. }

Functions

Namesort descending Description
blank_degrees_display_blank_degree
blank_degrees_menu Implementation of hook_menu
blank_degrees_menu_handle_replacement_pattern This is an implementation of hook_menu_handle_replacement_pattern. It will search for and replace replacement patterns which we are aware of it in $str.
blank_degrees_perm
blank_degrees_prereqs_get_prereq_warnings_for_course Implements hook_prereqs_get_prereq_warnings_for_course
blank_degrees_select_degree_form This form lets the user select which degree they wish to view.
blank_degrees_select_degree_form_submit Submit handler for degree selection
blank_degrees_select_school_form