NF_Notifications

Main Notifications Class.

Defined (1)

The class is defined in the following location(s).

/deprecated/classes/notifications.php  
  1. class NF_Notifications 
  2. { 
  3.     /** 
  4.      * Get things rolling 
  5.      * 
  6.      * @access public 
  7.      * 
  8.      * @since 2.8 
  9.      */ 
  10.     function __construct() { 
  11.         global $pagenow; 
  12.  
  13.         // Register our notification types 
  14.         Ninja_Forms()->notification_types['email'] = require_once( NF_PLUGIN_DIR . 'classes/notification-email.php' ); 
  15.         Ninja_Forms()->notification_types['redirect'] = require_once( NF_PLUGIN_DIR . 'classes/notification-redirect.php' ); 
  16.         Ninja_Forms()->notification_types['success_message'] = require_once( NF_PLUGIN_DIR . 'classes/notification-success-message.php' ); 
  17.  
  18.         Ninja_Forms()->notification_types = apply_filters( 'nf_notification_types', Ninja_Forms()->notification_types ); 
  19.  
  20.         // Register our notification tab 
  21.         add_action( 'admin_init', array( $this, 'register_tab' ) ); 
  22.  
  23.         // Only add these actions if we are actually on the notification tab. 
  24.         if ( 'admin.php' == $pagenow && isset ( $_REQUEST['page'] ) && $_REQUEST['page'] == 'ninja-forms' && isset ( $_REQUEST['tab'] ) && $_REQUEST['tab'] == 'notifications' ) { 
  25.             add_action( 'admin_init', array( $this, 'add_js' ) ); 
  26.             add_action( 'admin_init', array( $this, 'add_css' ) ); 
  27.             add_action( 'admin_init', array( $this, 'bulk_actions' ) ); 
  28.             add_action( 'admin_init', array( $this, 'duplicate_notification' ) ); 
  29.             add_filter( 'media_buttons_context', array( $this, 'tinymce_buttons' ) ); 
  30.         } 
  31.  
  32.         add_action( 'wp_ajax_nf_delete_notification', array( $this, 'delete_notification' ) ); 
  33.         add_action( 'wp_ajax_nf_activate_notification', array( $this, 'activate_notification' ) ); 
  34.         add_action( 'wp_ajax_nf_deactivate_notification', array( $this, 'deactivate_notification' ) ); 
  35.  
  36.  
  37.  
  38.         // Add our hook to add notification types processors. 
  39.         add_action( 'ninja_forms_post_process', array( $this, 'notification_processing' ), 999 ); 
  40.     } 
  41.  
  42.     /** 
  43.      * Register our setting tab. 
  44.      * 
  45.      * @access public 
  46.      * 
  47.      * @since 2.8 
  48.      * @return void 
  49.      */ 
  50.     public function register_tab() { 
  51.         $form_id = isset ( $_REQUEST['form_id'] ) ? absint( $_REQUEST['form_id'] ) : ''; 
  52.         $action = isset ( $_REQUEST['notification-action'] ) ? esc_html( $_REQUEST['notification-action'] ) : ''; 
  53.         $output_form = false; 
  54.         $show_save = false; 
  55.         if ( 'edit' == $action || 'new' == $action ) { 
  56.             $output_form = true; 
  57.             $show_save = true; 
  58.         } 
  59.  
  60.         $args = array( 
  61.             'name' => __( 'Email & Actions', 'ninja-forms' ),  
  62.             'page' => 'ninja-forms',  
  63.             'display_function' => array( $this, 'output_admin' ),  
  64.             'save_function' => array( $this, 'save_admin' ),  
  65.             'disable_no_form_id' => true,  
  66.             'show_save' => $show_save,  
  67.             'tab_reload' => true,  
  68.             'output_form' => $output_form,  
  69.  ); 
  70.  
  71.         ninja_forms_register_tab( 'notifications', $args ); 
  72.     } 
  73.  
  74.     /** 
  75.      * Enqueue JS 
  76.      * 
  77.      * @access public 
  78.      * @since 2.8 
  79.      * @return void 
  80.      */ 
  81.     public function add_js() { 
  82.         global $ninja_forms_fields; 
  83.  
  84.         $form_id = isset ( $_REQUEST['form_id'] ) ? absint( $_REQUEST['form_id'] ) : ''; 
  85.         if ( empty ( $form_id ) ) 
  86.             return false; 
  87.  
  88.         if ( defined( 'NINJA_FORMS_JS_DEBUG' ) && NINJA_FORMS_JS_DEBUG ) { 
  89.             $suffix = ''; 
  90.             $src = 'dev'; 
  91.         } else { 
  92.             $suffix = '.min'; 
  93.             $src = 'min'; 
  94.         } 
  95.  
  96.         wp_enqueue_script( 'nf-notifications',  
  97.         NF_PLUGIN_URL . 'assets/js/' . $src .'/notifications' . $suffix . '.js',  
  98.         array( 'jquery', 'jquery-ui-autocomplete' ) ); 
  99.  
  100.         wp_enqueue_script( 'nf-tokenize',  
  101.         NF_PLUGIN_URL . 'assets/js/' . $src .'/bootstrap-tokenfield' . $suffix . '.js',  
  102.         array( 'jquery', 'jquery-ui-autocomplete' ) ); 
  103.  
  104.         wp_enqueue_script( 'nf-combobox',  
  105.         NF_PLUGIN_URL . 'assets/js/' . $src .'/combobox' . $suffix . '.js',  
  106.         array( 'jquery', 'jquery-ui-core', 'jquery-ui-button', 'jquery-ui-autocomplete' ) ); 
  107.  
  108.         $all_fields = Ninja_Forms()->form( $form_id )->fields; 
  109.         $process_fields = array(); 
  110.         $search_fields = array(); 
  111.         $search_fields['email'] = array(); 
  112.         $search_fields['name'] = array(); 
  113.         $fields = array(); 
  114.         // Generate our search fields JS var. 
  115.         foreach( $all_fields as $field_id => $field ) { 
  116.             $label = esc_attr( nf_get_field_admin_label( $field_id ) ); 
  117.  
  118.             $fields[ $field_id ] = array( 'field_id' => $field_id, 'label' => $label ); 
  119.  
  120.             if ( strlen( $label ) > 30 ) { 
  121.                 $tmp_label = substr( $label, 0, 30 ); 
  122.             } else { 
  123.                 $tmp_label = $label; 
  124.             } 
  125.  
  126.             $tmp_array = array( 'value' => 'field_' . $field_id, 'label' => $tmp_label . ' - ID: ' . $field_id ); 
  127.  
  128.             $admin_label = $label; 
  129.  
  130.             $label = isset( $field['data']['label'] ) ? $field['data']['label'] : ''; 
  131.  
  132.             // Check to see if this field is supposed to be "processed" 
  133.             $type = $field['type']; 
  134.             if ( isset ( $ninja_forms_fields[ $type ]['process_field'] ) && $ninja_forms_fields[ $type ]['process_field'] ) { 
  135.                 $process_fields[ $field_id ] = array( 'field_id' => $field_id, 'label' => $label, 'admin_label' => $admin_label ); 
  136.                 $search_fields['all'][] = $tmp_array; 
  137.             } 
  138.  
  139.             if ( $field['type'] == '_text' && isset ( $field['data']['email'] ) && $field['data']['email'] == 1 ) { 
  140.                 $search_fields['email'][] = $tmp_array; 
  141.             } else if ( $field['type'] == '_text' && isset ( $field['data']['first_name'] ) && $field['data']['first_name'] == 1 ) { 
  142.                 $search_fields['name'][] = $tmp_array; 
  143.             } else if ( $field['type'] == '_text' && isset ( $field['data']['last_name'] ) && $field['data']['last_name'] == 1 ) { 
  144.                 $search_fields['name'][] = $tmp_array; 
  145.             } 
  146.         } 
  147.  
  148.         // Add our "process_fields" to our form global 
  149.         Ninja_Forms()->form( $form_id )->process_fields = $process_fields; 
  150.  
  151.         $js_vars = apply_filters( 'nf_notification_admin_js_vars', array( 
  152.             'activate' => __( 'Activate', 'ninja-forms' ),  
  153.             'deactivate' => __( 'Deactivate', 'ninja-forms' ),  
  154.             'search_fields' => $search_fields,  
  155.             'tokens' => array(),  
  156.             'all_fields' => $fields,  
  157.             'process_fields' => $process_fields,  
  158.             'filter_type' => esc_url_raw( remove_query_arg( array( 'type' ) ) ),  
  159.  ) ); 
  160.  
  161.         wp_localize_script( 'nf-notifications', 'nf_notifications', $js_vars ); 
  162.  
  163.     } 
  164.  
  165.     /** 
  166.      * Enqueue CSS 
  167.      * 
  168.      * @access public 
  169.      * @since 2.8 
  170.      * @return void 
  171.      */ 
  172.     public function add_css() { 
  173.         wp_enqueue_style( 'nf-notifications',  
  174.         NF_PLUGIN_URL . 'assets/css/notifications.css' ); 
  175.  
  176.         wp_enqueue_style( 'nf-tokenize',  
  177.         NF_PLUGIN_URL . 'assets/css/bootstrap-tokenfield.css' ); 
  178.  
  179.         wp_enqueue_style( 'nf-combobox',  
  180.         NF_PLUGIN_URL . 'assets/css/combobox.css' ); 
  181.  
  182.         // wp_enqueue_style( 'nf-bootstrap',  
  183.         // 'http://netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css' ); 
  184.     } 
  185.  
  186.     /** 
  187.      * Output our notifications admin. 
  188.      * 
  189.      * @access public 
  190.      * 
  191.      * @since 2.8 
  192.      * @return void 
  193.      */ 
  194.     public function output_admin() { 
  195.         $action = isset ( $_REQUEST['notification-action'] ) ? esc_html( $_REQUEST['notification-action'] ) : ''; 
  196.  
  197.         ?> 
  198.         <div class="wrap"> 
  199.             <?php 
  200.         if ( '' == $action ) { 
  201.             ?> 
  202.             <h2><?php _e( 'Email & Actions', 'ninja-forms' ); ?> <a href="<?php echo esc_url( add_query_arg( array( 'notification-action' => 'new' ) ) ); ?>" class="add-new-h2"><?php _e( 'Add New', 'ninja-forms' );?></a></h2> 
  203.  
  204.             <!-- Forms are NOT created automatically, so you need to wrap the table in one to use features like bulk actions --> 
  205.                <form id="forms-filter" method="get"> 
  206.                 <!-- For plugins, we also need to ensure that the form posts back to our current page --> 
  207.                 <input type="hidden" name="page" value="<?php echo esc_attr( $_REQUEST['page'] ); ?>" /> 
  208.                 <input type="hidden" name="tab" value="<?php echo esc_attr( $_REQUEST['tab'] ); ?>" /> 
  209.                 <input type="hidden" name="form_id" value="<?php echo esc_attr( $_REQUEST['form_id'] ); ?>" /> 
  210.                 <?php 
  211.                 //Create an instance of our package class... 
  212.                 $nf_all_forms = new NF_Notifications_List_Table(); 
  213.                 //Fetch, prepare, sort, and filter our data... 
  214.                 $nf_all_forms->prepare_items(); 
  215.                  // Now we can render the completed list table 
  216.                 $nf_all_forms->display(); 
  217.                 ?> 
  218.             </form> 
  219.             <?php 
  220.         } else { 
  221.             $id = isset ( $_REQUEST['id'] ) ? absint( $_REQUEST['id'] ) : ''; 
  222.             if ( $id == '' ) { 
  223.                 $id = 'new'; 
  224.                 $this_type = 'email'; 
  225.                 $title = __( 'New Action', 'ninja-forms' ); 
  226.             } else { 
  227.                 $this_type = Ninja_Forms()->notification( $id )->type; 
  228.                 $title = __( 'Edit Action', 'ninja-forms' ) . ' - ID ' . $id; 
  229.             } 
  230.  
  231.             ?> 
  232.             <h2><?php echo $title; ?> <a href="<?php echo esc_url( remove_query_arg( array( 'notification-action', 'id', 'update_message' ) ) );?>" class="button-secondary"><?php _e( 'Back To List', 'ninja-forms' );?></a></h2> 
  233.  
  234.             <input type="hidden" id="notification_id" name="notification_id" value="<?php echo $id; ?>" /> 
  235.             <table class="form-table"> 
  236.                 <tbody id="notification-main"> 
  237.                     <tr> 
  238.                         <th scope="row"><label for="setting-name"><?php _e( 'Action Name', 'ninja-forms' ); ?></label></th> 
  239.                         <td><input name="settings[name]" type="text" id="settings-name" value="<?php echo nf_get_object_meta_value( $id, 'name' ); ?>" class="regular-text"></td> 
  240.                     </tr> 
  241.                     <tr> 
  242.                         <th scope="row"><label for="type"><?php _e( 'Type', 'ninja-forms' ); ?></label></th> 
  243.                         <td> 
  244.                             <select name="settings[type]" id="settings-type"> 
  245.                                 <?php 
  246.                                 foreach ( $this->get_types() as $slug => $nicename ) { 
  247.                                     ?> 
  248.                                     <option value="<?php echo $slug; ?>" <?php selected ( $this_type, $slug ); ?>><?php echo $nicename; ?></option> 
  249.                                     <?php 
  250.                                 } 
  251.                                 ?> 
  252.                             </select> 
  253.                             <span class="nf-more-actions"><a href="<?php echo nf_aff_link( 'https://ninjaforms.com/extensions/?display=actions&utm_medium=plugin&utm_source=action-single&utm_campaign=Ninja+Forms+Upsell&utm_content=Ninja+Forms+Actions' ); ?>" target="_blank"><?php _e( 'Get More Actions', 'ninja-forms' ); ?> <span class="dashicons dashicons-external"></span></a></span> 
  254.                         </td> 
  255.                     </tr> 
  256.                 </tbody> 
  257.                 <?php 
  258.                 do_action( 'nf_edit_notification_settings', $id ); 
  259.                 foreach ( $this->get_types() as $slug => $nicename ) { 
  260.                     if ( $this_type == $slug ) { 
  261.                         $display = ''; 
  262.                     } else { 
  263.                         $display = 'display:none;'; 
  264.                     } 
  265.                     ?> 
  266.                     <tbody id="notification-<?php echo $slug; ?>" class="notification-type" style="<?php echo $display;?>"> 
  267.                         <?php 
  268.                             // Call our type edit screen. 
  269.                             Ninja_Forms()->notification_types[ $slug ]->edit_screen( $id ); 
  270.                         ?> 
  271.                     </tbody> 
  272.                     <?php 
  273.                 } 
  274.                 ?> 
  275.             </table> 
  276.             <?php 
  277.         } ?> 
  278.  
  279.         </div> 
  280.         <?php 
  281.     } 
  282.  
  283.     /** 
  284.      * Save our notifications admin. 
  285.      * 
  286.      * @access public 
  287.      * 
  288.      * @since 2.8 
  289.      * @return void 
  290.      */ 
  291.     public function save_admin( $form_id, $data ) { 
  292.         if ( ! isset ( $data['notification_id'] ) || empty ( $data['notification_id'] ) ) 
  293.             return false; 
  294.  
  295.         $n_id = $data['notification_id']; 
  296.         $settings = $data['settings']; 
  297.  
  298.         if ( 'new' == $n_id ) { 
  299.             $type = $settings['type']; 
  300.             $n_id = $this->create( $form_id ); 
  301.             $new = true; 
  302.         } else { 
  303.             $type = Ninja_Forms()->notification( $n_id )->type; 
  304.             $new = false; 
  305.         } 
  306.  
  307.         $data = Ninja_Forms()->notification_types[ $type ]->save_admin( $n_id, $data ); 
  308.  
  309.         foreach ( $settings as $meta_key => $meta_value ) { 
  310.             nf_update_object_meta( $n_id, $meta_key, nf_wp_kses_post_deep( $meta_value ) ); 
  311.         } 
  312.  
  313.         do_action( 'nf_save_notification', $n_id, $data, $new ); 
  314.  
  315.         if ( $new ) { 
  316.             $redirect = esc_url_raw( remove_query_arg( array( 'notification-action' ) ) ); 
  317.             $redirect = esc_url_raw( add_query_arg( array( 'id' => $n_id, 'notification-action' => 'edit', 'update_message' => urlencode( __( 'Action Updated', 'ninja-forms' ) ) ), $redirect ) ); 
  318.             wp_redirect( $redirect ); 
  319.             die(); 
  320.         } 
  321.  
  322.         return __( 'Action Updated', 'ninja-forms' ); 
  323.     } 
  324.  
  325.     /** 
  326.      * Get our registered notification types 
  327.      * 
  328.      * @access public 
  329.      * @since 2.8 
  330.      * @return array $types 
  331.      */ 
  332.     public function get_types() { 
  333.         $types = array(); 
  334.         foreach ( Ninja_Forms()->notification_types as $slug => $object ) { 
  335.             $types[ $slug ] = $object->name; 
  336.         } 
  337.         return $types; 
  338.     } 
  339.  
  340.     /** 
  341.      * Delete a notification. 
  342.      * Hooked into the ajax action for nf_delete_notification 
  343.      * 
  344.      * @access public 
  345.      * @since 2.8 
  346.      * @return void 
  347.      */ 
  348.     public function delete_notification() { 
  349.         // Bail if our nonce doesn't verify. 
  350.         check_ajax_referer( 'nf_ajax', 'nf_ajax_nonce' ); 
  351.  
  352.         $n_id = absint( $_REQUEST['n_id'] ); 
  353.         Ninja_Forms()->notification( $n_id )->delete(); 
  354.     } 
  355.  
  356.     /** 
  357.      * Activate a notification. 
  358.      * Hooked into the ajax action for nf_activate_notification 
  359.      * 
  360.      * @access public 
  361.      * @since 2.8 
  362.      * @return void 
  363.      */ 
  364.     public function activate_notification() { 
  365.         // Bail if our nonce doesn't verify. 
  366.         check_ajax_referer( 'nf_ajax', 'nf_ajax_nonce' ); 
  367.  
  368.         $n_id = absint( $_REQUEST['n_id'] ); 
  369.         Ninja_Forms()->notification( $n_id )->activate(); 
  370.     } 
  371.  
  372.     /** 
  373.      * Deactivate a notification. 
  374.      * Hooked into the ajax action for nf_deactivate_notification 
  375.      * 
  376.      * @access public 
  377.      * @since 2.8 
  378.      * @return void 
  379.      */ 
  380.     public function deactivate_notification() { 
  381.         // Bail if our nonce doesn't verify. 
  382.         check_ajax_referer( 'nf_ajax', 'nf_ajax_nonce' ); 
  383.  
  384.         $n_id = absint( $_REQUEST['n_id'] ); 
  385.         Ninja_Forms()->notification( $n_id )->deactivate(); 
  386.     } 
  387.  
  388.     /** 
  389.      * Duplicate our notification 
  390.      * 
  391.      * @access public 
  392.      * @since 2.8 
  393.      * @return void 
  394.      */ 
  395.     public function duplicate_notification() { 
  396.         if ( ! isset ( $_REQUEST['notification-action'] ) || $_REQUEST['notification-action'] != 'duplicate' ) 
  397.             return false; 
  398.  
  399.         $n_id = isset ( $_REQUEST['id'] ) ? absint( $_REQUEST['id'] ) : ''; 
  400.  
  401.         // Bail if we don't have an ID. 
  402.         if ( '' === $n_id ) 
  403.             return false; 
  404.  
  405.         Ninja_Forms()->notification( $n_id )->duplicate(); 
  406.  
  407.         wp_redirect( esc_url_raw( remove_query_arg( array( 'notification-action' ) ) ) ); 
  408.         die(); 
  409.     } 
  410.  
  411.     /** 
  412.      * Create a new notification 
  413.      * 
  414.      * @access public 
  415.      * @since 2.8 
  416.      * @return int $n_id 
  417.      */ 
  418.     public function create( $form_id = '' ) { 
  419.         // Bail if we don't have a form_id 
  420.         if ( '' == $form_id ) 
  421.             return false; 
  422.  
  423.         $n_id = nf_insert_notification( $form_id ); 
  424.  
  425.         // Activate our new notification 
  426.         Ninja_Forms()->notification( $n_id )->activate(); 
  427.  
  428.         return $n_id; 
  429.     } 
  430.  
  431.     /** 
  432.      * Handle bulk actions 
  433.      * 
  434.      * @access public 
  435.      * @since 2.8 
  436.      * @return void 
  437.      */ 
  438.     public function bulk_actions() { 
  439.         $action = ''; 
  440.  
  441.         if ( isset( $_REQUEST['action2'] ) && -1 != $_REQUEST['action2'] ) 
  442.             $action = esc_html( $_REQUEST['action2'] ); 
  443.  
  444.         if ( isset( $_REQUEST['action'] ) && -1 != $_REQUEST['action'] ) 
  445.             $action = esc_html( $_REQUEST['action'] ); 
  446.  
  447.         $n_ids = isset ( $_REQUEST['notification'] ) ? esc_html( $_REQUEST['notification'] ) : ''; 
  448.  
  449.         if ( ! is_array( $n_ids ) || empty( $n_ids ) ) 
  450.             return false; 
  451.  
  452.         if( 'delete' === $action ) { 
  453.             foreach ( $n_ids as $n_id ) { 
  454.                 Ninja_Forms()->notification( $n_id )->delete(); 
  455.             } 
  456.         } else if ( 'activate' === $action ) { 
  457.             foreach ( $n_ids as $n_id ) { 
  458.                 Ninja_Forms()->notification( $n_id )->activate(); 
  459.             } 
  460.         } else if ( 'deactivate' === $action ) { 
  461.             foreach ( $n_ids as $n_id ) { 
  462.                 Ninja_Forms()->notification( $n_id )->deactivate(); 
  463.             } 
  464.         } 
  465.  
  466.         wp_redirect( esc_url_raw( remove_query_arg( array( 'notification', '_wpnonce', '_wp_http_referer', 'action', 'action2' ) ) ) ); 
  467.         die(); 
  468.     } 
  469.  
  470.     /** 
  471.      * Output our tinyMCE field buttons 
  472.      * 
  473.      * @access public 
  474.      * @since 2.8 
  475.      * @return void 
  476.      */ 
  477.     public function tinymce_buttons( $context ) { 
  478.         $form_id = isset ( $_REQUEST['form_id'] ) ? absint( $_REQUEST['form_id'] ) : ''; 
  479.         if ( empty ( $form_id ) ) 
  480.             return $context; 
  481.  
  482.         $all_fields = Ninja_Forms()->form( $form_id )->process_fields; 
  483.         $first_option = __( 'Select a field or type to search', 'ninja-forms' ); 
  484.  
  485.         $fields = array(); 
  486.         $html = '<select class="nf-fields-combobox" data-first-option="' . $first_option . '">'; 
  487.         $html .= '<option value="">' . $first_option .'</option>'; 
  488.         foreach( $all_fields as $field_id => $field ) { 
  489.             $label = esc_html( $field['label'] ); 
  490.             if ( strlen( $label ) > 30 ) 
  491.                 $label = substr( $label, 0, 30 ) . '...'; 
  492.  
  493.             $html .= '<option value="' . $field_id . '">' . $label . ' - ID: ' . $field_id . '</option>'; 
  494.         } 
  495.         $html .= '</select>'; 
  496.         $html .= ' <a href="#" class="button-secondary nf-insert-field">' . __( 'Insert Field', 'ninja-forms' ) . '</a> <a href="#" class="button-secondary nf-insert-all-fields">' . __( 'Insert All Fields', 'ninja-forms' ) . '</a>'; 
  497.  
  498.         return $html; 
  499.     } 
  500.  
  501.     /** 
  502.      * Loop through our notifications and add their processing functions to the appropriate hook. 
  503.      * 
  504.      * @access public 
  505.      * @since 2.8 
  506.      * @return void 
  507.      */ 
  508.     public function notification_processing() { 
  509.         global $ninja_forms_processing; 
  510.  
  511.         $form_id = $ninja_forms_processing->get_form_ID(); 
  512.         $notifications = nf_get_notifications_by_form_id( $form_id, false ); 
  513.         if ( is_array( $notifications ) ) { 
  514.             foreach ( $notifications as $id ) { 
  515.                 do_action( 'nf_notification_before_process', $id ); 
  516.                 if ( Ninja_Forms()->notification( $id )->active ) { 
  517.                     Ninja_Forms()->notification( $id )->process(); 
  518.                 } 
  519.             } 
  520.         } 
  521.     } 
  522.  
  523. }