Functions
Search API
Primary tabs
| 
            Name | 
                  Location | Description | 
|---|---|---|
| engagements_get_signalwire_sms_error_codes_array | 
            modules/ | 
                  |
| engagements_get_sms_from_history | 
            modules/ | 
                  |
| engagements_get_users_to_be_notified_for_sms_on_number | 
            modules/ | 
                  Returns an array of all the user who should receive notifications when we receive an SMS at a particular number. | 
| engagements_get_user_notify_sms_receipt_values | 
            modules/ | 
                  Get an array of numbers which the user should be notified of when they receive an SMS. | 
| engagements_handle_incoming_sms | 
            modules/ | 
                  This catches incoming sms messages from POST, but can also be used by our "sms_get_all_messages" function, but it is also used by the sms_get_all_messages to save/update information. | 
| engagements_handle_sms_stop | 
            modules/ | 
                  This function is called by engagements_handle_incoming_sms, when we receive 'STOP' from the user. We must add them to our "sms_do_not_txt" table, and send a reply letting them know how to re-subscribe in the future. | 
| engagements_handle_sms_unstop | 
            modules/ | 
                  User opted-IN to receiving txt messages. | 
| engagements_handle_tracking_pixel_request | 
            modules/ | 
                  The user has opened an email with a tracking pixel. We will now record that it was opened in our engagements_tracking table. | 
| engagements_imap_get_all_received_messages | 
            modules/ | 
                  Connect to our imap server, download all received messages from students (or others). We will then delete them, so they don't get read twice. | 
| engagements_imap_settings_form | 
            modules/ | 
                  Configure the imap settings used by Engagements | 
| engagements_install | 
            modules/ | 
                  Hook install. Called when the module is installed on the admin modules page. | 
| engagements_mass_sms_form | 
            modules/ | 
                  |
| engagements_mass_sms_form_submit | 
            modules/ | 
                  Our submit function. Our main task is simply to set off a batch routine. | 
| engagements_mass_sms_form_validate | 
            modules/ | 
                  |
| engagements_mass_sms_perform_batch_operation | 
            modules/ | 
                  |
| engagements_menu | 
            modules/ | 
                  Implement hook_menu | 
| engagements_menu_handle_replacement_pattern | 
            modules/ | 
                  implements hook_menu_handle_replacement_pattern | 
| engagements_perm | 
            modules/ | 
                  |
| engagements_send_email_or_txt_form_submit | 
            modules/ | 
                  |
| engagements_send_email_or_txt_form_validate | 
            modules/ | 
                  |
| engagements_send_sms_to_number | 
            modules/ | 
                  Actually send a text message. Will drupal_set_message() as an error if there is a problem, and return FALSE. Returns TRUE on success, no drupal_set_message is printed. | 
| engagements_sms_get_all_messages | 
            modules/ | 
                  Retrieve all messages, update the ones which don't have prices associated with them yet. | 
| engagements_sms_replace_patterns | 
            modules/ | 
                  |
| engagements_sms_settings_form | 
            modules/ | 
                  Configure the various SMS settings | 
| engagements_update | 
            modules/ | 
                  |
| example_define_calculation_tests | 
            modules/ | 
                  Implements hook_define_calculation_tests, "METHOD ONE" from above. Accept an array so we can alter. Then, we are just going to add to array (or modify). | 
| example_helper_display_hello_world_page | 
            custom/ | 
                  Display our Hello World page to the user. | 
| example_helper_init | 
            custom/ | 
                  Implementation of "hook_init". | 
| example_helper_menu | 
            custom/ | 
                  Implementation of hook_menu | 
| example__is_student_gpa_above_250 | 
            modules/ | 
                  |
| filter_markup | 
            includes/ | 
                  Filter string with possible HTML, allowing only certain tags, and removing dangerous attributes. | 
| filter_xss | 
            includes/ | 
                  This function is taken almost directly from Drupal 7's core code. It is used to help us filter out dangerous HTML which the user might type. From the D7 documentation: | 
| filter_xss_attributes | 
            includes/ | 
                  |
| filter_xss_bad_protocol | 
            includes/ | 
                  |
| filter_xss_split | 
            includes/ | 
                  Like the filter_xss function, this is taken from D7's _filter_xss_split function | 
| flightpath_is_cli | 
            ./ | 
                  Returns TRUE or FALSE if we are in CLI mode. Borrowed code from Drupal 7: https://api.drupal.org/api/drupal/includes!bootstrap.inc/function/drupal... | 
| format_date | 
            includes/ | 
                  Format a timestamp using the date command. TODO: Make the formats something which can be controlled through the settings. | 
| form_basic_validate | 
            includes/ | 
                  This is a very basic validator 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). | 
| fpm | 
            includes/ | 
                  Uses fp_add_message, but in this case, it also adds in the filename and line number which the message came from! | 
| fpmct | 
            includes/ | 
                  Convenience function, will use fp_debug_ct() to display a message, and the number of miliseconds since its last call. | 
| fp_add_body_class | 
            includes/ | 
                  Add a CSS class to the body tag of the page. Useful for themeing later on. | 
| 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_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_build_sub_tab_array | 
            includes/ | 
                  Create a "sub-tab" array, which looks like a standard tab_array, but it contains only this page's sub-tab siblings. | 
| fp_build_tab_array | 
            includes/ | 
                  Looks at the current page array and returns a valid $tab_array Meant for the top of the screen. | 
| fp_clear_cache | 
            includes/ | 
                  Call all modules which implement hook_clear_cache | 
| fp_debug_ct | 
            includes/ | 
                  Shortcut to fp_debug_current_time_millis() | 
