Functions
Search API
Primary tabs
Name |
Location | Description |
|---|---|---|
| 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_description |
includes/ |
Convert a term ID into a description. Ex: 20095 = Spring of 2009. |
| 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_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". |
| 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). |
| fp_validate_utf8 |
includes/ |
|
| 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_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_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_theme_location |
includes/ |
Return the theme location |
| fp_strip_dangerous_protocols |
includes/ |
|
| fp_show_title |
includes/ |
Sets whether the title should be shown on the page or not. |
| fp_set_title |
includes/ |
Allows the programmer to set the title of the page, overwriting any default title. |
| 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_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_render_tab_array |
includes/ |
Given a propperly formatted tab_array, this will return the HTML to draw it on a page. |
| fp_render_sub_tab_array |
includes/ |
Similar to render_tab_array. |
| fp_render_square_line |
includes/ |
Will draw a string in a pretty square box. Used for displaying semester titles. |
| fp_render_mobile_tab_array |
includes/ |
|
| fp_render_menu_item |
includes/ |
|
| fp_render_menu_block |
includes/ |
Render a "menu" block of menu items which are all rooted at the menu_root. So if the menu root is tools, it might return items whose paths look like: tools/fun tools/here/there So long as the menu type is "MENU_TYPE_NORMAL_ITEM". … |
| fp_render_greeting |
includes/ |
This displays a friendly message to the user, and provides a logout link at the top. |
| 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… |
| 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… |
| fp_render_c_fieldset |
includes/ |
This function will return the HTML to contruct a collapsible fieldset, complete with javascript and style tags. |
| fp_render_curved_line |
includes/ |
Will draw a string in a pretty curved box. Used for displaying semester titles. |
| fp_render_currently_advising_box |
includes/ |
Draws the CurrentlyAdvisingBox which appears at the top of the screen, containing the student's information like name, major, etc. |
| fp_render_button |
includes/ |
Returns the HTML to draw a pretty button. |
| fp_reduce_whitespace |
includes/ |
Simple helper function to reduce whitespace (like double-spaces) |
| fp_rebuild_modules_list |
includes/ |
Re-query the modules table and re-add to our global array. |
| fp_number_pad |
includes/ |
Simple function to left padd numbers with 0's. 1 becomes 001 20 becomes 020 and so on. |
| 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. |
| fp_http_request |
includes/ |
Send a request through the Internet and return the result as an object. |
| fp_html_print_r |
includes/ |
Similar to print_r, this will return an HTML-friendly click-to-open system similar in design to Krumo. |
| fp_goto |
includes/ |
Redirect the user's browser to the specified internal path + query. |
| fp_get_system_settings |
includes/ |
|
| fp_get_student_name |
includes/ |
|
| fp_get_permissions_for_role |
includes/ |
|
| fp_get_module_path |
includes/ |
Return the filepath to the module |
| fp_get_module_details |
includes/ |
Simply returns the module's row from the modules table, if it exists. |
| fp_get_machine_readable |
includes/ |
Simple function to convert a string into a machine-readable string. |
| fp_get_js_prompt_link |
includes/ |
Creates a javascript "prompt" link, which will ask the user a question. |
| 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_alert_link |
includes/ |
Creates a javascript "alert" link, which tells the user some message with javascript alert(). |
| 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. |
| fp_get_faculty_name |
includes/ |
Returns the faculty member's name based on the ID provided. |
| fp_display_page |
includes/ |
Output the contents of the $page variable to the screen. $page is an array containing details about the page, as well as its original menu item (router_item) definition. |
| 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. |