course_search.api.php

File

modules/course_search/course_search.api.php
View source
  1. <?php
  2. /**
  3. * These are hooks that other modules may take advantage of from the course_search module
  4. */
  5. /**
  6. * This is called AFTER the regular course rotation schedule array has been built. Notice it is passed by reference. This lets us
  7. * make alterations to it.
  8. */
  9. function hook_course_search_get_course_rotation_schedule(&$schedule_array, $course_id, $year, $limit, $bool_include_next_five_years) {
  10. // ... Make changes to $schedule_array
  11. // Nothing to return, since $schedule_array is passed by reference.
  12. }
  13. /**
  14. * This is called AFTER the regular course_search_get_course_rotation_schedule_not_anticipated. In general, we want to see if
  15. * anything is going to be offered in the next 5 years.
  16. */
  17. function hook_course_search_get_course_rotation_schedule_not_anticipated(&$rtn, $course_id) {
  18. // Make changes here...
  19. // Nothing to return since our $rtn is passed by reference
  20. }

Functions

Namesort descending Description
hook_course_search_get_course_rotation_schedule This is called AFTER the regular course rotation schedule array has been built. Notice it is passed by reference. This lets us make alterations to it.
hook_course_search_get_course_rotation_schedule_not_anticipated This is called AFTER the regular course_search_get_course_rotation_schedule_not_anticipated. In general, we want to see if anything is going to be offered in the next 5 years.