Functions
Search API
Primary tabs
Name |
Location | Description |
|---|---|---|
| fp_render_square_line |
includes/ |
Will draw a string in a pretty square box. Used for displaying semester titles. |
| fp_render_sub_tab_array |
includes/ |
Similar to render_tab_array. |
| fp_render_tab_array |
includes/ |
Given a propperly formatted tab_array, this will return the HTML to draw it on a page. |
| fp_screen_is_mobile |
includes/ |
This function will attempt to determine automatically if we are on a mobile device, and should therefor use the mobile theme and layout settings. |
| fp_set_page_sub_tabs |
includes/ |
Allows the programmer to define subtabs at the top of the page. |
| fp_set_page_tabs |
includes/ |
If this function is called, it will override any other page tabs which might be getting constructed. This lets the programmer, at run-time, completely control what tabs are at the top of the page. |
| fp_set_title |
includes/ |
Allows the programmer to set the title of the page, overwriting any default title. |
| fp_show_title |
includes/ |
Sets whether the title should be shown on the page or not. |
| fp_strip_dangerous_protocols |
includes/ |
|
| fp_theme_location |
includes/ |
Return the theme location |
| fp_token |
includes/ |
Returns back the site's "token", which is a simply md5 of some randomness. It is used primarily with forms, to ensure against cross-site forgeries. The site's token gets saved to the variables table, for later use. The idea is… |
| fp_truncate_decimals |
includes/ |
This simple function will take a number and truncate the number of decimals to the requested places. This can be used in place of number_format(), which *rounds* numbers. |
| fp_url |
includes/ |
This function will take a path, ex: "admin/config/module" and a query, ex: "nid=5&whatever=yes" And join them together, respecting whether or not clean URL's are enabled. |
| fp_validate_utf8 |
includes/ |
|
| get_global_database_handler |
includes/ |
This method will return a globally-set DatabaseHandler object, creating it if it does not already exist. This is for efficiency reasons, so every module or method does not need to keep creating databasehandler objects (and re-connecting to the database). |
| get_modules_menus |
includes/ |
Similar to get_modules_permissions, this will scan through all installed modules' hook_menu() functions, and assemble an array which is sorted by "location" and then by "weight". |
| get_modules_permissions |
includes/ |
This function will read through all the modules' permissions and return back an array. Specifically, it retrieves arrays from each modules' hook_perm() function. |
| get_shorter_catalog_year_range |
includes/ |
This is used usually when being viewed by a mobile device. It will shorten a catalog year range of 2008-2009 to just "08-09" or "2008-09" or even "09-2009". |
| get_term_description |
includes/ |
Convert a term ID into a description. Ex: 20095 = Spring of 2009. |
| get_term_id_suffixes |
includes/ |
This looks at the global termIDStructure setting and returns back an array of only term suffixes (like 40, 60, mm, etc). |
| get_term_structures |
includes/ |
Return an array version of the term_id_structure field from the admin settings |
| hex2rgb |
inc/ |
|
| hook_advise_build_screen_elements |
modules/ |
This is a hook which developers may use to add custom blocks (or perform other operations) onto the advising View or What If screen. |
| hook_advise_build_screen_elements |
includes/ |
This hook allows other modules to interact with the AdvisingScreen object adter the build_screen_elements method is called. |
| hook_alter_currently_advising_box |
includes/ |
This will let us re-arrange or add new elements to the Currently Advising box, which appears at the top of the screen once a student has been selected (or for a student when they log in). |
| hook_alter_term_id_prior_to_description |
includes/ |
This hook is called right before retrieving the plain English description for a term_id. It allows modules to change the term_id. |
| hook_apply_draft_changes |
includes/ |
Allows modules to execute code when the admin user has chose to "apply draft changes". |
| hook_blocks |
modules/ |
Example of hook_blocks. |
| hook_clear_cache |
includes/ |
Allows each module to perform actions when the cache is cleared. |
| hook_content_alter |
includes/ |
Similar to hook_form_alter, this function lets other modules alter content which is being rendered through the "render" system. |
| hook_content_load |
modules/ |
Sample hook for hook_content_load |
| hook_content_register_content_type |
modules/ |
Sample hook other modules implement to register a content type. |
| hook_courselist_find_match_allow_course |
includes/ |
This hook his called just before returning a Course object from CourseList::find_best_grade_match or find_most_recent_match. |
| hook_course_load |
includes/ |
Allows modules to act after a course object has been loaded. |
| hook_cron |
includes/ |
This hook is called every time the system cron is run. |
| hook_degree_plan_load |
includes/ |
Allows modules to hook in after a degree plan object is created & loaded. |
| hook_disable |
includes/ |
This hook will be executed when a module is disabled in the system. |
| hook_enable |
includes/ |
This hook will be executed when a module is enabled in the system. It will be executed AFTER hook_install. |
| hook_exit |
includes/ |
Allows each module to execute code when the FlightPath page is completely finished. |
| hook_flightpath_can_assign_course_to_degree_id |
includes/ |
Is the course allowed to be assigned to the specified degree? Returns TRUE or FALSE |
| hook_flightpath_can_assign_course_to_group |
includes/ |
Is the course allowed to be assigned to the specified group? Returns TRUE or FALSE. $group should be a fully formed Group object. |
| hook_form_alter |
includes/ |
Alter forms which are created using the Form API |
| hook_fp_get_student_majors |
includes/ |
Returns a full listing of the student's majors. |
| hook_group_load |
includes/ |
Allows modules to act after a group object has been loaded. |
| hook_init |
includes/ |
Allows each module to execute code when the module is first loaded. |
| hook_install |
includes/ |
This hook will be executed the first time a module is enabled in the system. |
| hook_menu |
includes/ |
Allows modules to specify valid URLs in FlightPath, and define what function to call when the user visits that URL. |
| hook_menu_alter |
includes/ |
This hook lets us make alterations to menu items before saving them to the database. |
| hook_menu_handle_replacement_pattern |
includes/ |
This hook is called by the menu system. It allows each module the change to replace string patterns in its menu items (defined in hook_menu). |
| hook_perm |
includes/ |
This hook defines available permissions for a module. These perms are used with hook_menu() and the function user_has_permission() |