Functions

Primary tabs

Contains filters are case sensitive
Namesort descending Location Description
fp_render_menu_item includes/theme.inc
fp_render_mobile_tab_array includes/theme.inc
fp_render_square_line includes/theme.inc Will draw a string in a pretty square box. Used for displaying semester titles.
fp_render_sub_tab_array includes/theme.inc Similar to render_tab_array.
fp_render_tab_array includes/theme.inc Given a propperly formatted tab_array, this will return the HTML to draw it on a page.
fp_screen_is_mobile includes/misc.inc 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/misc.inc Allows the programmer to define subtabs at the top of the page.
fp_set_page_tabs includes/misc.inc 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/misc.inc Allows the programmer to set the title of the page, overwriting any default title.
fp_show_title includes/theme.inc Sets whether the title should be shown on the page or not.
fp_strip_dangerous_protocols includes/misc.inc
fp_theme_location includes/theme.inc Return the theme location
fp_token includes/misc.inc 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/misc.inc 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/misc.inc 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/misc.inc
get_global_database_handler includes/misc.inc 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/misc.inc 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/misc.inc 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/misc.inc 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/misc.inc Convert a term ID into a description. Ex: 20095 = Spring of 2009.
get_term_id_suffixes includes/misc.inc 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/misc.inc Return an array version of the term_id_structure field from the admin settings
hook_advise_build_screen_elements modules/advise/advise.module 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_blocks modules/blocks/blocks.module Example of hook_blocks.
hook_clear_cache includes/hook.api.php Allows each module to perform actions when the cache is cleared.
hook_content_load modules/content/content.module Sample hook for hook_content_load
hook_content_register_content_type modules/content/content.module Sample hook other modules implement to register a content type.
hook_cron includes/hook.api.php This hook is called every time the system cron is run.
hook_disable includes/hook.api.php This hook will be executed when a module is disabled in the system.
hook_enable includes/hook.api.php This hook will be executed when a module is enabled in the system. It will be executed AFTER hook_install.
hook_exit includes/hook.api.php Allows each module to execute code when the FlightPath page is completely finished.
hook_form_alter includes/hook.api.php Alter forms which are created using the Form API
hook_init includes/hook.api.php Allows each module to execute code when the module is first loaded.
hook_install includes/hook.api.php This hook will be executed the first time a module is enabled in the system.
hook_menu includes/hook.api.php Allows modules to specify valid URLs in FlightPath, and define what function to call when the user visits that URL.
hook_menu_handle_replacement_pattern includes/hook.api.php 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/hook.api.php This hook defines available permissions for a module. These perms are used with hook_menu() and the function user_has_permission()
hook_render_block modules/blocks/blocks.module Example of hook_render_block
hook_save_advising_session includes/hook.api.php This hook allows modules to perform extra functions just after an advising session is saved by the system.
hook_status includes/hook.api.php Reports status information which each module is aware of, visible on admin/config/status.
hook_student_load includes/hook.api.php Allows modules to hook in after a new student object is created.
hook_submit includes/hook.api.php Handle submissions from the Form API
hook_uninstall includes/hook.api.php This hook will be executed when a module is "uninstalled" in the system. Once a module is disabled, an "uninstall" link will appear.
hook_update includes/hook.api.php Handle needed database updates when user updates a module.
hook_user_login includes/hook.api.php Perform actions when the user logs in successfully.
hook_validate includes/hook.api.php Validates form submissions from the Form API
include_module includes/misc.inc This will find and include the module in question, calling it's hook_init() function if it has one.
include_module_install includes/misc.inc Find and include the module's .install file, if it exists. Returns TRUE or FALSE if it was able to find & include the file.
install_check_requirements ./install.php Check for missing requirements of the system.

Pages