Functions
Search API
Primary tabs
| Name |
Location |
Description |
|---|---|---|
| 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". |
| fp_number_pad |
includes/ |
Simple function to left padd numbers with 0's. 1 becomes 001 20 becomes 020 and so on. |
| fp_debug_ct |
includes/ |
Shortcut to fp_debug_current_time_millis() |
| fp_debug_current_time_millis |
includes/ |
When called repeatedly, this function will display a message along with a milisecond count out to the side. Very useful for developers to time function calls or queries, to see how long they are taking. |
| fp_get_machine_readable |
includes/ |
Simple function to convert a string into a machine-readable string. |
| fp_add_body_class |
includes/ |
Add a CSS class to the body tag of the page. Useful for themeing later on. |
| fp_get_js_alert_link |
includes/ |
Creates a javascript "alert" link, which tells the user some message with javascript alert(). |
| fp_reduce_whitespace |
includes/ |
Simple helper function to reduce whitespace (like double-spaces) |
| get_term_structures |
includes/ |
Return an array version of the term_id_structure field from the admin settings |
| fp_get_module_details |
includes/ |
Simply returns the module's row from the modules table, if it exists. |
| 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. |
| menu_rebuild_cache |
includes/ |
Go through all installed modules and rebuild the menu_router table, based on each module's hook_menu function. |
| menu_get_module_path |
includes/ |
|
| menu_check_user_access |
includes/ |
Looks at the router item's details (from menu_get_item) and returns TRUE or FALSE if the user can access this item. |
| menu_execute_page_request |
includes/ |
|
| menu_get_items_beginning_with |
includes/ |
Return menu_items whose path begins with the menu_root. Ex: "tools" would return tools/fun and tools/here/there |
| menu_get_items_in_tab_family |
includes/ |
|
| menu_get_item |
includes/ |
Figure out which menu_router path matches the supplied path and return it. |
| menu_convert_replacement_pattern |
includes/ |
Look for modules implementing hook_menu_handle_replacement_pattern, and apply to str. |
| menu_get_menu_router_item_from_db |
includes/ |
Return array from menu_router for this item. * |
| hook_form_alter |
includes/ |
Alter forms which are created using the Form API |
| hook_validate |
includes/ |
Validates form submissions from the Form API |
| hook_submit |
includes/ |
Handle submissions from the Form API |
| hook_update |
includes/ |
Handle needed database updates when user updates a module. |
| hook_clear_cache |
includes/ |
Allows each module to perform actions when the cache is cleared. |
| hook_cron |
includes/ |
This hook is called every time the system cron is run. |
| hook_install |
includes/ |
This hook will be executed the first time a module is enabled 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_disable |
includes/ |
This hook will be executed when a module is disabled in the system. |
| hook_uninstall |
includes/ |
This hook will be executed when a module is "uninstalled" in the system. Once a module is disabled, an "uninstall" link will appear. |
| hook_init |
includes/ |
Allows each module to execute code when the module is first loaded. |
| hook_user_login |
includes/ |
Perform actions when the user logs in successfully. |
| hook_perm |
includes/ |
This hook defines available permissions for a module. These perms are used with hook_menu() and the function user_has_permission() |
| 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_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_save_advising_session |
includes/ |
This hook allows modules to perform extra functions just after an advising session is saved by the system. |
| hook_status |
includes/ |
Reports status information which each module is aware of, visible on admin/config/status. |
| hook_exit |
includes/ |
Allows each module to execute code when the FlightPath page is completely finished. |
| hook_student_load |
includes/ |
Allows modules to hook in after a new student object is created. |
| fp_get_form |
includes/ |
This function gets the form array, where the callback is the same as form_id. It will also look for modules which may want to alter the form, using hook_form_alter, and go ahead and apply that. |
| form_field_sort_compare_by_weight |
includes/ |
This function is meant to be used by the uasort command, to help re-order a form array based on each element's weight value. If weight is blank, it is assumed to be 0 (zero). |
| fp_render_form |
includes/ |
Render the form array from the callback to the screen, and set the form to save itself in our default submit handler. Valid form_types are: "system_settings" => values automatically saved to variables table. "normal" or BLANK… |
| clear_session_form_values |
includes/ |
Clear the form submissions variable from the SESSION for this callback. |
| form_basic_validate |
includes/ |
This is a very basic valiator for form API submission. All I really care about is making sure required fields have a value in them. If they do not, we will file a form_error. |
| form_error |
includes/ |
Register a form_error in the SESSION. |
| form_has_errors |
includes/ |
Returns TRUE or FALSE if there have been errors for this form submission (We will just look in the SESSION to find out). |
| fp_render_form_element |
includes/ |
Returns the HTML to render this form element to the screen. $name is the HTML machine name. $element is an array containing all we need to render it. If you want default values to be taken from the SESSION (because we had form_errors, say, and… |
| watchdog |
includes/ |
Add a log entry to the watchdog (log) table. |
| fp_get_faculty_name |
includes/ |
Returns the faculty member's name based on the ID provided. |
| fp_load_user |
includes/ |
Returns back a user object for this user_id. If the user is not found in the users table, it will return NULL. If the user_id requested is 0, the anonymous user object is returned. |