NF_Notifications_List_Table

The Ninja Forms NF Notifications List Table class.

Defined (1)

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

/deprecated/classes/notifications-table.php  
  1. class NF_Notifications_List_Table extends WP_List_Table { 
  2.  
  3.     /** 
  4.      * @var form_id 
  5.      */ 
  6.     var $form_id = ''; 
  7.  
  8.     /** ************************************************************************ 
  9.      * REQUIRED. Set up a constructor that references the parent constructor. We 
  10.      * use the parent reference to set some default configs. 
  11.      ***************************************************************************/ 
  12.     function __construct() { 
  13.         global $status, $page; 
  14.  
  15.         //Set parent defaults 
  16.         parent::__construct( array( 
  17.             'singular' => 'notification', //singular name of the listed records 
  18.             'plural' => 'notifications', //plural name of the listed records 
  19.             'ajax' => false        //does this table support ajax? 
  20.  ) ); 
  21.  
  22.         $this->form_id = isset ( $_REQUEST['form_id'] ) ? absint( $_REQUEST['form_id'] ) : ''; 
  23.  
  24.     } 
  25.  
  26.     /** ************************************************************************ 
  27.      * Recommended. This method is called when the parent class can't find a method 
  28.      * specifically build for a given column. Generally, it's recommended to include 
  29.      * one method for each column you want to render, keeping your package class 
  30.      * neat and organized. For example, if the class needs to process a column 
  31.      * named 'title', it would first see if a method named $this->column_title() 
  32.      * exists - if it does, that method will be used. If it doesn't, this one will 
  33.      * be used. Generally, you should try to use custom column methods as much as 
  34.      * possible. 
  35.      * 
  36.      * Since we have defined a column_title() method later on, this method doesn't 
  37.      * need to concern itself with any column with a name of 'title'. Instead, it 
  38.      * needs to handle everything else. 
  39.      * 
  40.      * For more detailed insight into how columns are handled, take a look at 
  41.      * WP_List_Table::single_row_columns() 
  42.      * 
  43.      * @param array $item A singular item (one full row's worth of data) 
  44.      * @param array $column_name The name/slug of the column to be processed 
  45.      * @return string Text or HTML to be placed inside the column <td> 
  46.      **************************************************************************/ 
  47.     public function column_default($item, $column_name) { 
  48.         switch($column_name) { 
  49.             case 'type': 
  50.                 return Ninja_Forms()->notification( $item['id'] )->type_name(); 
  51.             case 'date_updated': 
  52.                 return $item[$column_name]; 
  53.             default: 
  54.                 return print_r($item, true); //Show the whole array for troubleshooting purposes 
  55.         } 
  56.     } 
  57.  
  58.     /** ************************************************************************ 
  59.      * Recommended. This is a custom column method and is responsible for what 
  60.      * is rendered in any column with a name/slug of 'title'. Every time the class 
  61.      * needs to render a column, it first looks for a method named 
  62.      * column_{$column_title} - if it exists, that method is run. If it doesn't 
  63.      * exist, column_default() is called instead. 
  64.      * 
  65.      * This example also illustrates how to implement rollover actions. Actions 
  66.      * should be an associative array formatted as 'slug'=>'link html' - and you 
  67.      * will need to generate the URLs yourself. You could even ensure the links 
  68.      * 
  69.      * 
  70.      * @see WP_List_Table::::single_row_columns() 
  71.      * @param array $item A singular item (one full row's worth of data) 
  72.      * @return string Text to be placed inside the column <td> (movie title only) 
  73.      **************************************************************************/ 
  74.     public function column_name( $item ) { 
  75.  
  76.         $base_url = esc_url_raw( remove_query_arg( array( '_wp_http_referer', '_wpnonce' ) ) ); 
  77.  
  78.         $activate_text = ( Ninja_Forms()->notification( $item['id'] )->active ) ? __( 'Deactivate', 'ninja-forms' ) : __( 'Activate', 'ninja-forms' ); 
  79.  
  80.         $activate_action = ( Ninja_Forms()->notification( $item['id'] )->active ) ? 'deactivate' : 'activate'; 
  81.  
  82.         $activate_url = esc_url( add_query_arg( array( 'notification-action' => $activate_action, 'id' => $item['id'] ), $base_url ) ); 
  83.         $edit_url = esc_url( add_query_arg( array( 'notification-action' => 'edit', 'id' => $item['id'] ), $base_url ) ); 
  84.         $delete_url = esc_url( add_query_arg( array( 'action' => 'delete' ), $base_url ) ); 
  85.         $duplicate_url = esc_url( add_query_arg( array( 'notification-action' => 'duplicate', 'id' => $item['id'] ), $base_url ) ); 
  86.  
  87.         //Build row actions 
  88.         $actions = array( 
  89.             'active' => '<a href="' . $activate_url . '" class="notification-activate" data-action="' . $activate_action . '" data-n_id="' . $item['id'] . '">' . $activate_text . '</a>',  
  90.             'edit' => '<a href="' . $edit_url . '">' . __( 'Edit', 'ninja-forms' ) . '</a>',  
  91.             'delete' => '<a href="' . $delete_url .'" class="notification-delete" data-n_id="' . $item['id'] . '">' . __( 'Delete', 'ninja-forms' ) . '</a>',  
  92.             'duplicate' => '<a href="' . $duplicate_url .'">' . __( 'Duplicate', 'ninja-forms' ) . '</a>',  
  93.  ); 
  94.  
  95.         //Return the title contents 
  96.         return sprintf( '<a href="%1$s">%2$s</a> %3$s',  
  97.             /**$1%s*/ $edit_url,  
  98.             /**$2%s*/ $item['name'],  
  99.             /**$3%s*/ $this->row_actions($actions) 
  100.  ); 
  101.     } 
  102.  
  103.     /** ************************************************************************ 
  104.      * REQUIRED if displaying checkboxes or using bulk actions! The 'cb' column 
  105.      * is given special treatment when columns are processed. It ALWAYS needs to 
  106.      * have it's own method. 
  107.      * 
  108.      * @see WP_List_Table::::single_row_columns() 
  109.      * @param array $item A singular item (one full row's worth of data) 
  110.      * @return string Text to be placed inside the column <td> (movie title only) 
  111.      **************************************************************************/ 
  112.     public function column_cb($item) { 
  113.         return sprintf( 
  114.             '<input type="checkbox" name="%1$s[]" value="%2$s" />',  
  115.             /**$1%s*/ $this->_args['singular'], //Let's simply repurpose the table's singular label ("movie") 
  116.             /**$2%s*/ $item['id']                //The value of the checkbox should be the record's id 
  117.  ); 
  118.     } 
  119.  
  120.     /** ************************************************************************ 
  121.      * REQUIRED! This method dictates the table's columns and titles. This should 
  122.      * return an array where the key is the column slug (and class) and the value 
  123.      * is the column's title text. If you need a checkbox for bulk actions, refer 
  124.      * to the $columns array below. 
  125.      * 
  126.      * The 'cb' column is treated differently than the rest. If including a checkbox 
  127.      * column in your table you must create a column_cb() method. If you don't need 
  128.      * bulk actions or checkboxes, simply leave the 'cb' entry out of your array. 
  129.      * 
  130.      * @see WP_List_Table::::single_row_columns() 
  131.      * @return array An associative array containing column information: 'slugs'=>'Visible Titles' 
  132.      **************************************************************************/ 
  133.     public function get_columns() { 
  134.         $columns = array( 
  135.             'cb' => '<input type="checkbox" />', //Render a checkbox instead of text 
  136.             'name' => __( 'Name', 'ninja-forms' ),  
  137.             'type' => __( 'Type', 'ninja-forms' ),  
  138.             'date_updated' => __( 'Date Updated', 'ninja-forms' ),  
  139.  ); 
  140.         return $columns; 
  141.     } 
  142.  
  143.     /** ************************************************************************ 
  144.      * Optional. If you want one or more columns to be sortable (ASC/DESC toggle),  
  145.      * you will need to register it here. This should return an array where the 
  146.      * key is the column that needs to be sortable, and the value is db column to 
  147.      * sort by. Often, the key and value will be the same, but this is not always 
  148.      * the case (as the value is a column name from the database, not the list table). 
  149.      * 
  150.      * This method merely defines which columns should be sortable and makes them 
  151.      * clickable - it does not handle the actual sorting. You still need to detect 
  152.      * the ORDERBY and ORDER querystring variables within prepare_items() and sort 
  153.      * your data accordingly (usually by modifying your query). 
  154.      * 
  155.      * @return array An associative array containing all the columns that should be sortable: 'slugs'=>array('data_values', bool) 
  156.      **************************************************************************/ 
  157.     public function get_sortable_columns() { 
  158.         $sortable_columns = array( 
  159.             'name' => array( 'name', false ), //true means it's already sorted 
  160.             'type' => array( 'type', false ),  
  161.             'date_updated' => array( 'date_updated', false ) 
  162.  ); 
  163.         return $sortable_columns; 
  164.     } 
  165.  
  166.     /** ************************************************************************ 
  167.      * Optional. If you need to include bulk actions in your list table, this is 
  168.      * the place to define them. Bulk actions are an associative array in the format 
  169.      * 'slug'=>'Visible Title' 
  170.      * 
  171.      * If this method returns an empty value, no bulk action will be rendered. If 
  172.      * you specify any bulk actions, the bulk actions box will be rendered with 
  173.      * the table automatically on display(). 
  174.      * 
  175.      * Also note that list tables are not automatically wrapped in <form> elements,  
  176.      * so you will need to create those manually in order for bulk actions to function. 
  177.      * 
  178.      * @return array An associative array containing all the bulk actions: 'slugs'=>'Visible Titles' 
  179.      **************************************************************************/ 
  180.     public function get_bulk_actions() { 
  181.         $actions = array( 
  182.             'activate' => __( 'Activate', 'ninja-forms' ),  
  183.             'deactivate' => __( 'Deactivate', 'ninja-forms' ),  
  184.             'delete' => __( 'Delete', 'ninja-forms' ),  
  185.  ); 
  186.         return $actions; 
  187.     } 
  188.  
  189.     public function extra_tablenav( $which ) { 
  190.         if ( $which == 'bottom' ) 
  191.             return false; 
  192.  
  193.         if ( isset ( $_REQUEST['type'] ) ) { 
  194.             $type = esc_html( $_REQUEST['type'] ); 
  195.         } else { 
  196.             $type = ''; 
  197.         } 
  198.  
  199.         ?> 
  200.         <div class="alignleft actions"> 
  201.             <select name="type" id="filter-type"> 
  202.                 <option value="" <?php selected( $type, '' ); ?>><?php _e( '- View All Types', 'ninja-forms' ); ?></option> 
  203.                 <?php 
  204.                 foreach ( Ninja_Forms()->notifications->get_types() as $slug => $nicename ) { 
  205.                     ?> 
  206.                     <option value="<?php echo $slug; ?>" <?php selected( $type, $slug ); ?>><?php echo $nicename; ?></option> 
  207.                     <?php 
  208.                 } 
  209.                 ?> 
  210.             </select> 
  211.             <span class="nf-more-actions"><a href="<?php echo nf_aff_link( 'https://ninjaforms.com/extensions/?display=actions&utm_medium=plugin&utm_source=actions-table&utm_campaign=Ninja+Forms+Upsell&utm_content=Ninja+Forms+Actions' ); ?>" target="_blank"><?php _e( 'Get More Types', 'ninja-forms' ); ?> <span class="dashicons dashicons-external"></span></a></span> 
  212.             <span style="float:left;" class="spinner"></span> 
  213.         </div> 
  214.         <?php 
  215.     } 
  216.  
  217.     /** 
  218.      * Generates content for a single row of the table 
  219.      * 
  220.      * @since 3.1.0 
  221.      * @access protected 
  222.      * 
  223.      * @param object $item The current item 
  224.      */ 
  225.     function single_row( $item ) { 
  226.         static $alternate = ''; 
  227.  
  228.         $active = ( Ninja_Forms()->notification( $item['id'] )->active ) ? 'nf-notification-active ' : 'nf-notification-inactive'; 
  229.         $alternate = ( $alternate == '' ? 'alternate' : '' ); 
  230.  
  231.         echo '<tr class="' . $active . ' ' . $alternate . '" id="' . $item['id'] . '">'; 
  232.         $this->single_row_columns( $item ); 
  233.         echo '</tr>'; 
  234.     } 
  235.  
  236.     /** ************************************************************************ 
  237.      * REQUIRED! This is where you prepare your data for display. This method will 
  238.      * usually be used to query the database, sort and filter the data, and generally 
  239.      * get it ready to be displayed. At a minimum, we should set $this->items and 
  240.      * $this->set_pagination_args(), although the following properties and methods 
  241.      * are frequently interacted with here... 
  242.      * 
  243.      * @global WPDB $wpdb 
  244.      * @uses $this->_column_headers 
  245.      * @uses $this->items 
  246.      * @uses $this->get_columns() 
  247.      * @uses $this->get_sortable_columns() 
  248.      * @uses $this->get_pagenum() 
  249.      * @uses $this->set_pagination_args() 
  250.      **************************************************************************/ 
  251.     public function prepare_items() { 
  252.         global $wpdb; //This is used only if making any database queries 
  253.  
  254.         /** 
  255.          * First, lets decide how many records per page to show 
  256.          */ 
  257.         $per_page = 99999; 
  258.  
  259.  
  260.         /** 
  261.          * REQUIRED. Now we need to define our column headers. This includes a complete 
  262.          * array of columns to be displayed (slugs & titles), a list of columns 
  263.          * to keep hidden, and a list of columns that are sortable. Each of these 
  264.          * can be defined in another method (as we've done here) before being 
  265.          * used to build the value for our _column_headers property. 
  266.          */ 
  267.         $columns = $this->get_columns(); 
  268.         $hidden = array(); 
  269.         $sortable = $this->get_sortable_columns(); 
  270.  
  271.  
  272.         /** 
  273.          * REQUIRED. Finally, we build an array to be used by the class for column 
  274.          * headers. The $this->_column_headers property takes an array which contains 
  275.          * 3 other arrays. One for all columns, one for hidden columns, and one 
  276.          * for sortable columns. 
  277.          */ 
  278.         $this->_column_headers = array($columns, $hidden, $sortable); 
  279.  
  280.  
  281.         /** 
  282.          * Optional. You can handle your bulk actions however you see fit. In this 
  283.          * case, we'll handle them within our package just to keep things clean. 
  284.          */ 
  285.         //$this->process_bulk_action(); 
  286.  
  287.  
  288.         /** 
  289.          * Instead of querying a database, we're going to fetch the example data 
  290.          * property we created for use in this plugin. This makes this example 
  291.          * package slightly different than one you might build on your own. In 
  292.          * this example, we'll be using array manipulation to sort and paginate 
  293.          * our data. In a real-world implementation, you will probably want to 
  294.          * use sort and pagination data to build a custom query instead, as you'll 
  295.          * be able to use your precisely-queried data immediately. 
  296.          */ 
  297.         $notifications = nf_get_notifications_by_form_id( $this->form_id ); 
  298.         $data = array(); 
  299.  
  300.         if ( is_array( $notifications ) ) { 
  301.             foreach ( $notifications as $id => $n ) { 
  302.                 if ( isset ( $_REQUEST['type'] ) && ! empty( $_REQUEST['type'] ) ) { 
  303.                     if ( nf_get_object_meta_value( $id, 'type' ) == esc_html( $_REQUEST['type'] ) ) { 
  304.                         $n['id'] = $id; 
  305.                         $data[] = $n; 
  306.                     } 
  307.                 } else { 
  308.                     $n['id'] = $id; 
  309.                     $data[] = $n; 
  310.                 } 
  311.  
  312.             } 
  313.         } 
  314.  
  315.         /** 
  316.          * This checks for sorting input and sorts the data in our array accordingly. 
  317.          * 
  318.          * In a real-world situation involving a database, you would probably want 
  319.          * to handle sorting by passing the 'orderby' and 'order' values directly 
  320.          * to a custom query. The returned data will be pre-sorted, and this array 
  321.          * sorting technique would be unnecessary. 
  322.          */ 
  323.         function usort_reorder($a, $b) { 
  324.             $orderby = (!empty($_REQUEST['orderby'])) ? esc_html( $_REQUEST['orderby'] ) : 'name'; //If no sort, default to title 
  325.             $order = (!empty($_REQUEST['order'])) ? esc_html( $_REQUEST['order'] ) : 'asc'; //If no order, default to asc 
  326.             $result = strcmp($a[$orderby], $b[$orderby]); //Determine sort order 
  327.             return ($order==='asc') ? $result : -$result; //Send final sort direction to usort 
  328.         } 
  329.         usort($data, 'usort_reorder'); 
  330.  
  331.  
  332.         /*********************************************************************** 
  333.          * --------------------------------------------------------------------- 
  334.          * vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv 
  335.          * 
  336.          * In a real-world situation, this is where you would place your query. 
  337.          * 
  338.          * For information on making queries in WordPress, see this Codex entry: 
  339.          * http://codex.wordpress.org/Class_Reference/wpdb 
  340.          * 
  341.          * ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 
  342.          * --------------------------------------------------------------------- 
  343.          **********************************************************************/ 
  344.  
  345.  
  346.         /** 
  347.          * REQUIRED for pagination. Let's figure out what page the user is currently 
  348.          * looking at. We'll need this later, so you should always include it in 
  349.          * your own package classes. 
  350.          */ 
  351.         $current_page = $this->get_pagenum(); 
  352.  
  353.         /** 
  354.          * REQUIRED for pagination. Let's check how many items are in our data array. 
  355.          * In real-world use, this would be the total number of items in your database,  
  356.          * without filtering. We'll need this later, so you should always include it 
  357.          * in your own package classes. 
  358.          */ 
  359.         $total_items = count($data); 
  360.  
  361.  
  362.         /** 
  363.          * The WP_List_Table class does not handle pagination for us, so we need 
  364.          * to ensure that the data is trimmed to only the current page. We can use 
  365.          * array_slice() to 
  366.          */ 
  367.         $data = array_slice($data, (($current_page-1)*$per_page), $per_page); 
  368.  
  369.  
  370.  
  371.         /** 
  372.          * REQUIRED. Now we can add our *sorted* data to the items property, where 
  373.          * it can be used by the rest of the class. 
  374.          */ 
  375.         $this->items = $data; 
  376.  
  377.  
  378.         /** 
  379.          * REQUIRED. We also have to register our pagination options & calculations. 
  380.          */ 
  381.         $this->set_pagination_args( array( 
  382.             'total_items' => $total_items, //WE have to calculate the total number of items 
  383.             'per_page' => $per_page, //WE have to determine how many items to show on a page 
  384.             'total_pages' => ceil($total_items/$per_page)   //WE have to calculate the total number of pages 
  385.  ) ); 
  386.     } 
  387.  
  388. }