Functions
Search API
Primary tabs
| Name |
Location |
Description |
|---|---|---|
| get_term_structures |
includes/ |
Return an array version of the term_id_structure field from the admin settings |
| fp_get_requirement_types |
includes/ |
Returns back an array of all the available requirement types (by code) that have been defined. |
| fp_load_degree |
includes/ |
This function provides a pass-thru to $d = new DegreePlan(args). However, it allows for quick caching look-up, so it should be used when possible instead of $x = new DegreePlan. |
| 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_page_sub_tabs |
includes/ |
Allows the programmer to define subtabs 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_add_body_class |
includes/ |
Add a CSS class to the body tag of the page. Useful for themeing later on. |
| 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… |
| csv_to_array |
includes/ |
Simple function to split a basic CSV string, trim all elements, then return the resulting array. |
| fp_add_message |
includes/ |
Add a "message" to the top of the screen. Useful for short messages like "You have been logged out" or "Form submitted successfully." |
| fp_add_css |
includes/ |
Add an extra CSS file to the page with this function. Ex: fp_add_css(fp_get_module_path("admin") . '/css/admin.css'); |
| fp_add_js |
includes/ |
Add extra javascript to the page. |
| fp_join_assoc |
includes/ |
This function will create a string from a 1 dimensional assoc array. Ex: arr = array("pet" => "dog", "name" => "Rex") will return: pet-dog,name-Rex under the default settings. |
| fp_explode_assoc |
includes/ |
Takes a string (created by fp_join_assoc()) and re-creates the 1 dimensional assoc array. |
| fp_get_module_path |
includes/ |
Return the filepath to the module |
| fp_get_files_path |
includes/ |
Convenience function to return the /files system path. Does NOT end with a trailing slash. |
| fp_get_module_details |
includes/ |
Simply returns the module's row from the modules table, if it exists. |
| t |
includes/ |
This function will facilitate translations by using hook_translate() |
| st |
includes/ |
Provides translation functionality when database is not available. |
| base_path |
includes/ |
Shortcut for getting the base_path variable from the global system settings. |
| get_term_description |
includes/ |
Convert a term ID into a description. Ex: 20095 = Spring of 2009. |
| fp_goto |
includes/ |
Redirect the user's browser to the specified internal path + query. |
| l |
includes/ |
This works like Drupal's l() function for creating links. Ex: l("Click here for course search!", "tools/course-search", "abc=xyz&hello=goodbye", array("class" => "my-class")); Do not… |
| 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_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. |
| modules_implement_hook |
includes/ |
Return an array of enabled modules which implement the provided hook. Do not include the preceeding "_" on the hook name! |
| invoke_hook |
includes/ |
Invoke all module hooks for the supplied hook. |
| 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). |
| fpm |
includes/ |
Uses fp_add_message, but in this case, it also adds in the filename and line number which the message came from! |
| depricated_message |
includes/ |
Displays a depricated message on screen. Useful for tracking down when depricated functions are being used. |
| fpmct |
includes/ |
Convenience function, will use fp_debug_ct() to display a message, and the number of miliseconds since its last call. |
| fp_html_print_r |
includes/ |
Similar to print_r, this will return an HTML-friendly click-to-open system similar in design to Krumo. |
| 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". |
| include_module |
includes/ |
This will find and include the module in question, calling it's hook_init() function if it has one. |
| include_module_install |
includes/ |
Find and include the module's .install file, if it exists. Returns TRUE or FALSE if it was able to find & include the file. |
| fp_get_js_confirm_link |
includes/ |
Creates a javascript "confirm" link, so when clicked it asks the user a question, then proceeds if they select OK. The main reason I want to do this is so I can pass the $question through my t() function. (do it when you call this function) |
| fp_get_js_prompt_link |
includes/ |
Creates a javascript "prompt" link, which will ask the user a question. |
| 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) |
| user_has_role |
includes/ |
Does the user have the specified role? |
| user_has_permission |
includes/ |
Returns TRUE or FALSE if the logged in user has access based on the permission supplied. |
| 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_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_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_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_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. |
| _password_itoa64 |
includes/ |
Returns a string for mapping an int to the corresponding base 64 character. |
| _password_base64_encode |
includes/ |
Encodes bytes into printable base 64 using the *nix standard from crypt(). |